All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class com.sun.java.swing.text.Utilities 

java.lang.Object
   |
   +----com.sun.java.swing.text.Utilities
public class Utilities
extends Object
A collection of methods to deal with various text related activities.

Constructor Index

o Utilities()

Method Index

o drawTabbedText(Segment, int, int, Graphics, TabExpander, int)
Draws the given text, expanding any tabs that are contained using the given tab expansion technique.
o getBreakLocation(Segment, FontMetrics, int, int, TabExpander, int)
Determine where to break the given text to fit within the the given span.
o getNextWord(JTextComponent, int)
Determines the start of the next word for the given location.
o getParagraphElement(JTextComponent, int)
Determines the element to use for a paragraph/line.
o getPositionAbove(JTextComponent, int, int)
Determines the position in the model that is closest to the given view location in the row above.
o getPositionBelow(JTextComponent, int, int)
Determines the position in the model that is closest to the given view location in the row below.
o getPreviousWord(JTextComponent, int)
Determine the start of the next word for the given location.
o getRowEnd(JTextComponent, int)
Determines the ending row model position of the row that contains the specified model position.
o getRowStart(JTextComponent, int)
Determines the starting row model position of the row that contains the specified model position.
o getTabbedTextOffset(Segment, FontMetrics, int, int, TabExpander, int)
Determines the relative offset into the given text that best represents the given span in the view coordinate system.
o getTabbedTextWidth(Segment, FontMetrics, int, TabExpander, int)
Determines the width of the given segment of text taking tabs into consideration.
o getWordEnd(JTextComponent, int)
Determines the end of a word for the given location.
o getWordStart(JTextComponent, int)
Determines the start of a word for the given model location.

Constructors

o Utilities 
 public Utilities()

Methods

o drawTabbedText 
 public static final int drawTabbedText(Segment s,
                                        int x,
                                        int y,
                                        Graphics g,
                                        TabExpander e,
                                        int startOffset)
Draws the given text, expanding any tabs that are contained using the given tab expansion technique. This particular implementation renders in a 1.1 style coordinate system where ints are used and 72dpi is assumed.

Parameters:
s - the source of the text
x - the X origin >= 0
y - the Y origin >= 0
g - the graphics context
e - how to expand the tabs. If this value is null, tabs will be expanded as a space character.
startOffset - starting offset of the text in the document >= 0
Returns:
s the X location at the end of the rendered text
o getTabbedTextWidth 
 public static final int getTabbedTextWidth(Segment s,
                                            FontMetrics metrics,
                                            int x,
                                            TabExpander e,
                                            int startOffset)
Determines the width of the given segment of text taking tabs into consideration. This is implemented in a 1.1 style coordinate system where ints are used and 72dpi is assumed.

Parameters:
s - the source of the text
metrics - the font metrics to use for the calculation
x - the X origin >= 0
e - how to expand the tabs. If this value is null, tabs will be expanded as a space character.
startOffset - starting offset of the text in the document >= 0
Returns:
s the width of the text
o getTabbedTextOffset 
 public static final int getTabbedTextOffset(Segment s,
                                             FontMetrics metrics,
                                             int x0,
                                             int x,
                                             TabExpander e,
                                             int startOffset)
Determines the relative offset into the given text that best represents the given span in the view coordinate system. This is implemented in a 1.1 style coordinate system where ints are used and 72dpi is assumed.

Parameters:
s - the source of the text
metrics - the font metrics to use for the calculation
x0 - the starting view location representing the start of the given text >= 0.
x - the target view location to translate to an offset into the text >= 0.
e - how to expand the tabs. If this value is null, tabs will be expanded as a space character.
startOffset - starting offset of the text in the document >= 0
Returns:
s the offset into the text >= 0
o getBreakLocation 
 public static final int getBreakLocation(Segment s,
                                          FontMetrics metrics,
                                          int x0,
                                          int x,
                                          TabExpander e,
                                          int startOffset)
Determine where to break the given text to fit within the the given span. This trys to find a whitespace boundry.

Parameters:
s - the source of the text
metrics - the font metrics to use for the calculation
x0 - the starting view location representing the start of the given text.
x - the target view location to translate to an offset into the text.
e - how to expand the tabs. If this value is null, tabs will be expanded as a space character.
startOffset - starting offset in the document of the text
Returns:
s the offset into the given text.
o getRowStart 
 public static final int getRowStart(JTextComponent c,
                                     int offs) throws BadLocationException
Determines the starting row model position of the row that contains the specified model position. Assumes the row(s) are currently displayed in a view.

Parameters:
c - the editor
offs - the offset in the document >= 0
Returns:
the position >= 0
Throws: BadLocationException
if the offset is out of range
o getRowEnd 
 public static final int getRowEnd(JTextComponent c,
                                   int offs) throws BadLocationException
Determines the ending row model position of the row that contains the specified model position. Assumes the row(s) are currently displayed in a view.

Parameters:
c - the editor
offs - the offset in the document >= 0
Returns:
the position >= 0
Throws: BadLocationException
if the offset is out of range
o getPositionAbove 
 public static final int getPositionAbove(JTextComponent c,
                                          int offs,
                                          int x) throws BadLocationException
Determines the position in the model that is closest to the given view location in the row above.

Parameters:
c - the editor
offs - the offset in the document >= 0
x - the X coordinate >= 0
Returns:
the model position >= 0
Throws: BadLocationException
if the offset is out of range
o getPositionBelow 
 public static final int getPositionBelow(JTextComponent c,
                                          int offs,
                                          int x) throws BadLocationException
Determines the position in the model that is closest to the given view location in the row below.

Parameters:
c - the editor
offs - the offset in the document >= 0
x - the X coordinate >= 0
Returns:
the model position >= 0
Throws: BadLocationException
if the offset is out of range
o getWordStart 
 public static final int getWordStart(JTextComponent c,
                                      int offs) throws BadLocationException
Determines the start of a word for the given model location. Uses BreakIterator.getWordInstance() to actually get the words.

Parameters:
c - the editor
offs - the offset in the document >= 0
Returns:
s the location in the model of the word start >= 0.
Throws: BadLocationException
if the offset is out of range
o getWordEnd 
 public static final int getWordEnd(JTextComponent c,
                                    int offs) throws BadLocationException
Determines the end of a word for the given location. Uses BreakIterator.getWordInstance() to actually get the words.

Parameters:
c - the editor
offs - the offset in the document >= 0
Returns:
s the location in the model of the word end >= 0.
Throws: BadLocationException
if the offset is out of range
o getNextWord 
 public static final int getNextWord(JTextComponent c,
                                     int offs) throws BadLocationException
Determines the start of the next word for the given location. Uses BreakIterator.getWordInstance() to actually get the words.

Parameters:
c - the editor
offs - the offset in the document >= 0
Returns:
s the location in the model of the word start >= 0.
Throws: BadLocationException
if the offset is out of range
o getPreviousWord 
 public static final int getPreviousWord(JTextComponent c,
                                         int offs) throws BadLocationException
Determine the start of the next word for the given location. Uses BreakIterator.getWordInstance() to actually get the words.

Parameters:
c - the editor
offs - the offset in the document >= 0
Returns:
s the location in the model of the word start >= 0.
Throws: BadLocationException
if the offset is out of range
o getParagraphElement 
 public static final Element getParagraphElement(JTextComponent c,
                                                 int offs)
Determines the element to use for a paragraph/line.

Parameters:
c - the editor
offs - the starting offset in the document >= 0
Returns:
the element 
All Packages  Class Hierarchy  This Package  Previous  Next  Index